IApi.EnableRedundancy method

Enables cable redundancy. The last EtherCAT slave is connected to another network interface card on the computer so all the slaves can be communicated even if one cable is broken.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

KsError EnableRedundancy(
       bool Active
)

Function EnableRedundancy(
       Active As Boolean
) As KsError

Parameters

Active

Type: bool

true to enable, and false to disable redundancy. By default, it is false.

Return value

Type: KsError

A return code of a method.

Remarks

This feature requires Cable Redundancy Package.
This method must be called after Create or CreateAsync and before Start.
For more information about how redundancy works, see Concepts > EtherCAT cable redundancy.
When Redundancy is enabled and redundant cabling is deployed, if a cable has been unplugged from an EtherCAT slave, this slave can still be used but it may send an alarm.

Usable EtherCAT states

ecatOffline

Examples

N/A